Find everything you need to know about Coder all in one place. Access all documentation for Coder OSS for creating & managing CDEs today!

Open Source: Coder Docs | Coder

Learn how to install and run code-server using VS Code. Start here and access all documentation for code-server today!

code-server Docs: Run VS Code Anywhere | Coder

Start here and access all documentation for Coder Enterprise - all in one place. Discover all the features of our Enterprise solution today!

Enterprise: Coder Docs for Global Scale | Coder

All Coder v1 documentation in one place but keep in mind that Coder v1 is a retired product.  We encourage our customers to install Coder today!

Coder v1 Docs: Old Sunset Version | Coder

General

Agents

Applications

Applications Enterprise

Audit

Authentication

Authorization

Builds

Debug

Enterprise

Files

Insights

Members

Organizations

Schemas

Templates

Users

WorkspaceProxies

Workspaces

About

Architecture

Home

One-line install script for macOS and Linux

Install script

System packages for Debian, Ubuntu, Fedora, CentOS, RHEL, SUSE, and Alpine

System packages

macOS

Kubernetes

OpenShift

Install Coder with Docker / docker-compose

Docker

Windows

Download binaries for macOS, Windows, and Linux

Standalone binaries

Run Coder in offline / air-gapped environments

Offline deployments

External database

Uninstall

Installation

Azure

JFrog

Deploy workspaces on additional Kubernetes clusters

Additional clusters

Stream K8s event logs on workspace startup

Deployment logs

Other platforms

Platforms

Creating, editing, and updating templates

Working with templates

A tutorial for creating and editing your first template

Your first template

Guided tour

Change management

Provider authentication

Resource persistence

Terraform modules

Setting up templates

Show operational metrics in the workspace

Agent metadata

Show information in the workspace about template resources

Resource metadata

Prompt the user for additional information about a workspace

Parameters

Give information and options to workspace users

Customizing templates

Configure name, display info, and update polices

General settings

Permissions

Configuration settings for template admins

Administering templates

Add an "Open in Coder" button to your repos

Open in Coder

Use Docker inside containerized templates

Docker in workspaces

Devcontainers

Troubleshooting templates

Audit commands in workspaces with exectrace

Process Logging

Coder includes icons for popular cloud providers and programming languages for you to use

Icons

Templates define the infrastructure for workspaces

Learn how to configure web IDEs in your templates

Web IDEs

Learn how to configure JetBrains Gateway for your workspaces

JetBrains Gateway

Learn how to configure Emacs with TRAMP in Coder

Emacs

Learn how to use Remote Desktops with Coder

Remote Desktops

Learn how to use your IDE of choice with Coder

IDEs

Port Forwarding

Networking

Dotfiles

Learn how to use secrets in your workspace

Secrets

Learn how to set up authentication using GitHub or OpenID Connect

Learn about user roles available in Coder and how to create and manage users

Groups

Learn how to use the role based access control

RBAC

Configuration

Learn how connect Coder with external auth providers

External Auth

Upgrading

Learn how to automate Coder with the CLI and API

Automation

Reference architecture and load testing tools

Scaling Coder

Run provisioners isolated from the Coder server

External Provisioners

Workspace Proxies

Learn how to use Application Logs in your Coder deployment

Application Logs

Learn how to use Audit Logs in your Coder deployment

Audit Logs

Learn how to use Workspace Quotas in Coder

Quotas

Learn how to configure Coder for High Availability

High Availability

Prometheus

Learn how to configure the appearance of Coder

Appearance

Learn what usage telemetry Coder collects

Telemetry

Learn how to encrypt sensitive data at rest in Coder

Database Encryption

Learn how to monitor the health of your Coder deployment

Deployment Health

Administration

See the code of conduct for contributing to Coder

Code of Conduct

Policies for Alpha and Experimental features.

Feature stages

Our style guide for use when authoring documentation

Documentation

Security

Frontend

Contributing

Toggle auto-update policy for a workspace

autoupdate

coder

Add an SSH Host entry for your workspaces "ssh coder.workspace"

config-ssh

create

delete

Personalize your workspace by applying a canonical dotfiles repository

dotfiles

external-auth

external-auth access-token

features

features list

groups

groups create

groups delete

groups edit

groups list

licenses

licenses add

licenses delete

licenses list

list

login

logout

Print network debug information for DERP and STUN

netcheck

ping

Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R".

port-forward

provisionerd

provisionerd start

Output your Coder public key used for Git operations

publickey

rename

Directly connect to the database to reset a user's password

reset-password

restart

Schedule automated start and stop times for workspaces

schedule

Override the stop time of a currently running workspace instance.

schedule override-stop

schedule show

schedule start

schedule stop

server

Create a new admin user with the given username, email and password and adds it to every organization.